Claim Type Names
- Last UpdatedAug 06, 2021
- 3 minute read
An identity provider claim type name is the attribute needed when creating an identity provider claim.
List All Identity Provider Claim Type Names
Returns all identity provider claim type names for an identity provider on a tenant.
Request
GET /api/v1/IdentityProviders/{identityProviderId}/ClaimTypeNames
?query={query}&skip={skip}&count={count}
Parameters
string identityProviderId
Identity provider identifier.
[optional] string query
(Not supported) Search string identifier.[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | IdentityProviderClaimTypeName[] | List of identity provider type names found |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Identity provider not found |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (IdentityProviderClaimTypeName[])
[
{
"Id": "string",
"TypeName": "string",
"IdentityProviderId": "string"
}
]
Authorization
Allowed for these roles:
- Tenant Administrator
Get All Identity Provider Claim Type Names Header
Returns a header for all identity provider claim type names for an identity provider on a tenant.
Request
HEAD /api/v1/IdentityProviders/{identityProviderId}/ClaimTypeNames
Parameters
string identityProviderId
Identity provider identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Header for identity provider claim type names |
| 401 | None | Unauthorized. |
| 403 | None | Forbidden. |
| 404 | None | Identity provider not found |
| 500 | None | Internal server error. |
Authorization
Allowed for these roles:
- Tenant Administrator
Get Identity Provider Claim Type Name
Returns an identity provider claim type name from an identity provider.
Request
GET /api/v1/IdentityProviders/{identityProviderId}/ClaimTypeNames/{identityProviderClaimTypeNameId}
Parameters
string identityProviderId
Identity provider identifier.string identityProviderClaimTypeNameId
Identity provider claim type name identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | IdentityProviderClaim | Identity provider claim type name specified |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Identity provider or identity provider claim type name not found |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (IdentityProviderClaim)
{
"Id": "string",
"TypeName": "string",
"Value": "string",
"RoleIds": [
"string"
],
"IsBuiltIn": true
}
Authorization
Allowed for these roles:
- Tenant Administrator
Get Identity Provider Claim Type Name Header
Returns an identity provider claim type name header from an identity provider.
Request
HEAD /api/v1/IdentityProviders/{identityProviderId}/ClaimTypeNames/{identityProviderClaimTypeNameId}
Parameters
string identityProviderId
Identity provider identifier.string identityProviderClaimTypeNameId
Identity provider claim type name identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Header for identity provider claim type name specified |
| 401 | None | Unauthorized. |
| 403 | None | Forbidden. |
| 404 | None | Identity provider or identity provider claim type name not found |
| 500 | None | Internal server error. |
Authorization
Allowed for these roles:
- Tenant Administrator
Definitions
IdentityProviderClaimTypeName
Claim type name associated with an identity provider
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | guid | false | false | Claim type name identifier |
| TypeName | string | false | true | Claim type name |
| IdentityProviderId | guid | false | false | Identifier of identity provider associated with this claim type name |
{
"Id": "string",
"TypeName": "string",
"IdentityProviderId": "string"
}
ErrorResponse
Object returned whenever there is an error
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | true | false | Operation identifier of action that caused the error |
| Error | string | true | false | Error description |
| Reason | string | true | false | Reason for the error |
| Resolution | string | true | false | Resolution to resolve the error |
| DynamicProperties | object | false | true | Additional properties |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
IdentityProviderClaim
Object representing a claim from an identity provider to map to a role
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | guid | false | false | Identity provider claim identifier |
| TypeName | string | false | true | Type name for this identity provider claim |
| Value | string | false | true | Value for this identity provider claim |
| RoleIds | string[] | false | true | List of role identifiers that this claim on this identity provider will map |
| IsBuiltIn | boolean | false | false | Indicates if this claim entry is built-in. When this value is true, callers cannot modify or delete the claim. |
{
"Id": "string",
"TypeName": "string",
"Value": "string",
"RoleIds": [
"string"
],
"IsBuiltIn": true
}