GET/Users/{userId}

Gets member information.

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Users/{userId}

Path Parameters

ParameterTypeDescription
userId integer 

Member ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

See Get a Long-Lived Token for SCIM.


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
id string 

Member ID


readOnly : true 
externalId string 

ID managed by the SCIM client


maxLength : 100 
userName string 

Account. It is the same as the email address.

  • The format is localpart@domain.
  • The localpart must start with an English letter or a number.
  • The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
  • The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).

required
maxLength : 90 
name object (name) 

required 
displayName string 

Display name


readOnly : true 
nickName string 

Nickname

  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 100 
preferredLanguage string 

Language code


Allowed values : ko-KR, ja-JP, en-US, zh-CN, zh-TW 
timezone string 

Time zone


default : Time zone set for the domain 
active boolean 

Indicates whether the member is active.

  • true: Active
  • false: Suspended

This field must be set to true when adding a member.


default : true 
emails array (ScimUserEmail) 

Email information

 
phoneNumbers array (ScimUserPhoneNumber) 

Phone number information

 
ims array (ScimUserInstantMessage) 

Messenger information

 
urn:ietf:params:scim:schemas:extension:works:2.0:User object (urn:ietf:params:scim:schemas:extension:works:2.0:User) 
 
meta object (meta) 
 

name

PropertyTypeDescription
familyName stringnull 

Last name

  • The full name can be up to 80 characters long.
  • Either familyName or givenName must be specified.
  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 80 
givenName stringnull 

First name

  • The full name can be up to 80 characters long.
  • Either familyName or givenName must be specified.
  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 80 

ScimUserEmail

PropertyTypeDescription
type string 

Email type

  • alias: Secondary email
  • other: Personal email

required
Allowed values : alias, other 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Email

  • alias (secondary email)
    • Up to 90 characters
    • The format is localpart@domain.
    • The localpart must start with an English letter or a number.
    • The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
    • The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).
    • You can add up to 10 email aliases.
  • other (personal email)
    • It is required if SSO is not enabled.
    • The format is localpart@domain.
    • The local part can be up to 64 characters long.
    • The domain can be up to 253 characters long.

required 

ScimUserPhoneNumber

PropertyTypeDescription
type string 

Phone number type

  • work: Internal number
  • mobile: Mobile phone number

required
Allowed values : work, mobile 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Phone number


required
maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100} 

ScimUserInstantMessage

PropertyTypeDescription
type string 

Messenger type


required
Allowed values : work 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Messenger ID


required
minLength : 1
maxLength : 100 

urn:ietf:params:scim:schemas:extension:works:2.0:User

PropertyTypeDescription
userExternalKey stringnull 

Member external key.

Some special characters, %, , #, /, ? are not allowed.


maxLength : 100 

meta

PropertyTypeDescription
resourceType string 

Resource type


Allowed values : USER, GROUP 
created string 

Creation date

 
lastModified string 

Last update date

 
location string 

Resource URI

 

HTTP 404

Not Found